<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>ftcps</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="ftconv.html" title="ftconv" />
    <link rel="next" href="ftfree.html" title="ftfree" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">ftcps</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="ftconv.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="ftfree.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="ftcps"></a>
      <div class="titlepage"></div>
      <a id="IndexFtcps" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">ftcps</span>
        </h2>
        <p>ftcps — 
      Returns the base frequency of a stored function table in Hz.
          </p>
      </div>
      <div class="refsect1">
        <a id="idp111414960"></a>
        <h2>Description</h2>
        <p>
      Returns the base frequency of a stored function table in Hz..
    </p>
      </div>
      <div class="refsect1">
        <a id="idp111489152"></a>
        <h2>Syntax</h2>
        <pre class="synopsis"><span class="command"><strong>ftcps</strong></span>(x) (init-rate args only)</pre>
      </div>
      <div class="refsect1">
        <a id="idp111491216"></a>
        <h2>Performance</h2>
        <p>
      Returns the base frequency of stored function table, number <span class="emphasis"><em>x</em></span>.  <span class="emphasis"><em>ftcps</em></span> is designed for tables storing audio waveforms read from files (see <a class="link" href="GEN01.html" title="GEN01"><em class="citetitle">GEN01</em></a>). 
    </p>
        <p>
      <span class="emphasis"><em>ftcps</em></span> returns -1 in case of an error (no base frequency set in table or non-existent table).
    </p>
      </div>
      <div class="refsect1">
        <a id="idp111495328"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the ftcps opcode. 
      </p>
        <div class="example">
          <a id="idp111496384"></a>
          <p class="title">
            <strong>Example 329. Example of the ftcps opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out   Audio in</span>
-odac           -iadc    <span class="comment">;;;RT audio I/O</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o ftlen.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="comment">; Initialize the global variables.</span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">kr</span> <span class="op">=</span> 4410
<span class="ohdr">ksmps</span> <span class="op">=</span> 10
<span class="ohdr">nchnls</span> <span class="op">=</span> 1

<span class="comment">; Instrument #1.</span>
<span class="oblock">instr</span> 1
  <span class="comment">; Print out the base frequency of Table #1.</span>
  <span class="comment">; if it has been set in the original file.</span>
  icps <span class="op">=</span> <span class="opc">ftcps</span>(1)
  <span class="opc">print</span> icps
<span class="oblock">endin</span>


<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>

<span class="comment">; Table #1: Use an audio file, Csound will determine its base frequency, if set.</span>
<span class="stamnt">f</span> 1 0 0 1 "sample.wav" 0 0 0

<span class="comment">; Play Instrument #1 for 1 second.</span>
<span class="stamnt">i</span> 1 0 1
<span class="stamnt">e</span>


<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1">
        <a id="idp111500672"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="ftchnls.html" title="ftchnls"><em class="citetitle">ftchnls</em></a>, 
      <a class="link" href="ftlptim.html" title="ftlptim"><em class="citetitle">ftlptim</em></a>, 
      <a class="link" href="ftsr.html" title="ftsr"><em class="citetitle">ftsr</em></a>, 
      <a class="link" href="nsamp.html" title="nsamp"><em class="citetitle">nsamp</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp111505664"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Victor Lazzarini</td>
          </tr>
          <tr>
            <td>2010</td>
          </tr>
        </table>
        <p>
    </p>
        <p>Example written by Victor Lazzarini</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="ftconv.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="ftfree.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">ftconv </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> ftfree</td>
        </tr>
      </table>
    </div>
  </body>
</html>
